DOC - add markdown version of the docs#2191
Merged
Merged
Conversation
Member
Author
|
The llms.txt file can be accessed from the "rendered docs" by replacing index.html with llms.txt: Markdown files can be tested by adding the path reported in the llms.txt file after doc. Note that the paths have a different root: |
jeromedockes
approved these changes
Jul 2, 2026
| SKB_TABLE_REPORT_VERBOSITY=0 $(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| # Build markdown sources so llms.txt links point to .md files | ||
| SKB_TABLE_REPORT_VERBOSITY=0 SKIP_JUPYTERLITE=1 $(SPHINXBUILD) -D markdown_uri_doc_suffix="html.md" -D plot_gallery=0 -b markdown $(ALLSPHINXOPTS) $(BUILDDIR)/markdown |
Member
There was a problem hiding this comment.
does this double the time it takes to make html-noplot? (asking for a friend who finds it too slow already) if yes, maybe we can have a html-noplot-nomarkdown or similar
Member
Author
There was a problem hiding this comment.
yes it does, I'll add a command to only build the docs
jeromedockes
approved these changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR replaces part of #2173. Specifically, it adds the sphinx addons that generate the markdown documentation and the llms.txt file.